/
DbCollectionEntry`2.xml
308 lines (308 loc) · 18.5 KB
/
DbCollectionEntry`2.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
<Type Name="DbCollectionEntry<TEntity,TElement>" FullName="System.Data.Entity.Infrastructure.DbCollectionEntry<TEntity,TElement>">
<TypeSignature Language="C#" Value="public class DbCollectionEntry<TEntity,TElement> : System.Data.Entity.Infrastructure.DbMemberEntry<TEntity,System.Collections.Generic.ICollection<TElement>> where TEntity : class" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DbCollectionEntry`2<class TEntity, TElement> extends System.Data.Entity.Infrastructure.DbMemberEntry`2<!TEntity, class System.Collections.Generic.ICollection`1<!TElement>>" />
<TypeSignature Language="DocId" Value="T:System.Data.Entity.Infrastructure.DbCollectionEntry`2" />
<TypeSignature Language="VB.NET" Value="Public Class DbCollectionEntry(Of TEntity, TElement)
Inherits DbMemberEntry(Of TEntity, ICollection(Of TElement))" />
<TypeSignature Language="F#" Value="type DbCollectionEntry<'Entity, 'Element (requires 'Entity : null)> = class
 inherit DbMemberEntry<'Entity, ICollection<'Element> (requires 'Entity : null)>" />
<AssemblyInfo>
<AssemblyName>EntityFramework</AssemblyName>
<AssemblyVersion>4.3.1.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="TEntity">
<Constraints>
<ParameterAttribute>ReferenceTypeConstraint</ParameterAttribute>
</Constraints>
</TypeParameter>
<TypeParameter Name="TElement" />
</TypeParameters>
<Base>
<BaseTypeName>System.Data.Entity.Infrastructure.DbMemberEntry<TEntity,System.Collections.Generic.ICollection<TElement>></BaseTypeName>
<BaseTypeArguments>
<BaseTypeArgument TypeParamName="TEntity">TEntity</BaseTypeArgument>
<BaseTypeArgument TypeParamName="TProperty">System.Collections.Generic.ICollection<TElement></BaseTypeArgument>
</BaseTypeArguments>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="entity-framework-4.3.1;entity-framework-5.0.0">
<AttributeName>System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1709:IdentifiersShouldBeCasedCorrectly", Justification="FxCop rule is wrong; Database is not two words.", MessageId="Db")</AttributeName>
</Attribute>
</Attributes>
<Docs>
<typeparam name="TEntity"> The type of the entity to which this property belongs. </typeparam>
<typeparam name="TElement"> The type of the element in the collection of entities. </typeparam>
<summary>
Instances of this class are returned from the Collection method of
<see cref="T:System.Data.Entity.Infrastructure.DbEntityEntry`1" /> and allow operations such as loading to
be performed on the an entity's collection navigation properties.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="CurrentValue">
<MemberSignature Language="C#" Value="public override System.Collections.Generic.ICollection<TElement> CurrentValue { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.ICollection`1<!TElement> CurrentValue" />
<MemberSignature Language="DocId" Value="P:System.Data.Entity.Infrastructure.DbCollectionEntry`2.CurrentValue" />
<MemberSignature Language="VB.NET" Value="Public Overrides Property CurrentValue As ICollection(Of TElement)" />
<MemberSignature Language="F#" Value="member this.CurrentValue : System.Collections.Generic.ICollection<'Element> with get, set" Usage="System.Data.Entity.Infrastructure.DbCollectionEntry<'Entity, 'Element (requires 'Entity : null)>.CurrentValue" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>EntityFramework</AssemblyName>
<AssemblyVersion>4.3.1.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2227:CollectionPropertiesShouldBeReadOnly")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.ICollection<TElement></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the current value of the navigation property. The current value is
the entity that the navigation property references.
</summary>
<value> The current value. </value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EntityEntry">
<MemberSignature Language="C#" Value="public override System.Data.Entity.Infrastructure.DbEntityEntry<TEntity> EntityEntry { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Data.Entity.Infrastructure.DbEntityEntry`1<!TEntity> EntityEntry" />
<MemberSignature Language="DocId" Value="P:System.Data.Entity.Infrastructure.DbCollectionEntry`2.EntityEntry" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property EntityEntry As DbEntityEntry(Of TEntity)" />
<MemberSignature Language="F#" Value="member this.EntityEntry : System.Data.Entity.Infrastructure.DbEntityEntry<'Entity (requires 'Entity : null)>" Usage="System.Data.Entity.Infrastructure.DbCollectionEntry<'Entity, 'Element (requires 'Entity : null)>.EntityEntry" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>EntityFramework</AssemblyName>
<AssemblyVersion>4.3.1.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Data.Entity.Infrastructure.DbEntityEntry<TEntity></ReturnType>
</ReturnValue>
<Docs>
<summary>
The <see cref="T:System.Data.Entity.Infrastructure.DbEntityEntry`1" /> to which this navigation property belongs.
</summary>
<value> An entry for the entity that owns this navigation property. </value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsLoaded">
<MemberSignature Language="C#" Value="public bool IsLoaded { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsLoaded" />
<MemberSignature Language="DocId" Value="P:System.Data.Entity.Infrastructure.DbCollectionEntry`2.IsLoaded" />
<MemberSignature Language="VB.NET" Value="Public Property IsLoaded As Boolean" />
<MemberSignature Language="F#" Value="member this.IsLoaded : bool with get, set" Usage="System.Data.Entity.Infrastructure.DbCollectionEntry<'Entity, 'Element (requires 'Entity : null)>.IsLoaded" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>EntityFramework</AssemblyName>
<AssemblyVersion>4.3.1.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value indicating whether all entities of this collection have been loaded from the database.
</summary>
<value>
<c>true</c> if all the related entities are loaded or the IsLoaded has been explicitly set to true; otherwise, <c>false</c>.
</value>
<remarks>
Loading the related entities from the database either using lazy-loading, as part of a query, or explicitly
with one of the Load methods will set the IsLoaded flag to true.
IsLoaded can be explicitly set to true to prevent the related entities of this collection from being lazy-loaded.
This can be useful if the application has caused a subset of related entities to be loaded into this collection
and wants to prevent any other entities from being loaded automatically.
Note that explict loading using one of the Load methods will load all related entities from the database
regardless of whether or not IsLoaded is true.
When any related entity in the collection is detached the IsLoaded flag is reset to false indicating that the
not all related entities are now loaded.
</remarks>
</Docs>
</Member>
<Member MemberName="Load">
<MemberSignature Language="C#" Value="public void Load ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Load() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Entity.Infrastructure.DbCollectionEntry`2.Load" />
<MemberSignature Language="VB.NET" Value="Public Sub Load ()" />
<MemberSignature Language="F#" Value="member this.Load : unit -> unit" Usage="dbCollectionEntry.Load " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>EntityFramework</AssemblyName>
<AssemblyVersion>4.3.1.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Loads the collection of entities from the database.
Note that entities that already exist in the context are not overwritten with values from the database.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LoadAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task LoadAsync ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task LoadAsync() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Entity.Infrastructure.DbCollectionEntry`2.LoadAsync" />
<MemberSignature Language="VB.NET" Value="Public Function LoadAsync () As Task" />
<MemberSignature Language="F#" Value="member this.LoadAsync : unit -> System.Threading.Tasks.Task" Usage="dbCollectionEntry.LoadAsync " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>EntityFramework</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Asynchronously loads the collection of entities from the database.
Note that entities that already exist in the context are not overwritten with values from the database.
</summary>
<returns>
A task that represents the asynchronous operation.
</returns>
<remarks>
Multiple active operations on the same context instance are not supported. Use 'await' to ensure
that any asynchronous operations have completed before calling another method on this context.
</remarks>
</Docs>
</Member>
<Member MemberName="LoadAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task LoadAsync (System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task LoadAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Entity.Infrastructure.DbCollectionEntry`2.LoadAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="F#" Value="member this.LoadAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="dbCollectionEntry.LoadAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>EntityFramework</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" Index="0" FrameworkAlternate="entity-framework-6.2.0" />
</Parameters>
<Docs>
<param name="cancellationToken">
A <see cref="T:System.Threading.CancellationToken" /> to observe while waiting for the task to complete.
</param>
<summary>
Asynchronously loads the collection of entities from the database.
Note that entities that already exist in the context are not overwritten with values from the database.
</summary>
<returns>
A task that represents the asynchronous operation.
</returns>
<remarks>
Multiple active operations on the same context instance are not supported. Use 'await' to ensure
that any asynchronous operations have completed before calling another method on this context.
</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public override string Name { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:System.Data.Entity.Infrastructure.DbCollectionEntry`2.Name" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string" Usage="System.Data.Entity.Infrastructure.DbCollectionEntry<'Entity, 'Element (requires 'Entity : null)>.Name" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>EntityFramework</AssemblyName>
<AssemblyVersion>4.3.1.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the property name.
</summary>
<value> The property name. </value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="op_Implicit">
<MemberSignature Language="C#" Value="public static implicit operator System.Data.Entity.Infrastructure.DbCollectionEntry (System.Data.Entity.Infrastructure.DbCollectionEntry<TEntity,TElement> entry);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname class System.Data.Entity.Infrastructure.DbCollectionEntry op_Implicit(class System.Data.Entity.Infrastructure.DbCollectionEntry`2<!TEntity, !TElement> entry) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Entity.Infrastructure.DbCollectionEntry`2.op_Implicit(System.Data.Entity.Infrastructure.DbCollectionEntry{`0,`1})~System.Data.Entity.Infrastructure.DbCollectionEntry" />
<MemberSignature Language="VB.NET" Value="Public Shared Widening Operator CType (entry As DbCollectionEntry(Of TEntity, TElement)) As DbCollectionEntry" />
<MemberSignature Language="F#" Value="static member op_Implicit : System.Data.Entity.Infrastructure.DbCollectionEntry<'Entity, 'Element (requires 'Entity : null)> -> System.Data.Entity.Infrastructure.DbCollectionEntry" Usage="System.Data.Entity.Infrastructure.DbCollectionEntry<'Entity, 'Element (requires 'Entity : null)>.op_Implicit entry" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>EntityFramework</AssemblyName>
<AssemblyVersion>4.3.1.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Usage", "CA2225:OperatorOverloadsHaveNamedAlternates", Justification="Intentionally just implicit to reduce API clutter.")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Data.Entity.Infrastructure.DbCollectionEntry</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="entry" Type="System.Data.Entity.Infrastructure.DbCollectionEntry<TEntity,TElement>" />
</Parameters>
<Docs>
<param name="entry">The object representing the navigation property.</param>
<summary>
Returns a new instance of the non-generic <see cref="T:System.Data.Entity.Infrastructure.DbCollectionEntry" /> class for
the navigation property represented by this object.
</summary>
<returns> A non-generic version. </returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Query">
<MemberSignature Language="C#" Value="public System.Linq.IQueryable<TElement> Query ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Linq.IQueryable`1<!TElement> Query() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Entity.Infrastructure.DbCollectionEntry`2.Query" />
<MemberSignature Language="VB.NET" Value="Public Function Query () As IQueryable(Of TElement)" />
<MemberSignature Language="F#" Value="member this.Query : unit -> System.Linq.IQueryable<'Element>" Usage="dbCollectionEntry.Query " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>EntityFramework</AssemblyName>
<AssemblyVersion>4.3.1.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Linq.IQueryable<TElement></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Returns the query that would be used to load this collection from the database.
The returned query can be modified using LINQ to perform filtering or operations in the database, such
as counting the number of entities in the collection in the database without actually loading them.
</summary>
<returns> A query for the collection. </returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>